Repository navigation
Make the README concise and put the demo at the top - #67
Merged
Merged
Conversation
The README goes from 568 lines to 273. It now opens with the banner, a one-paragraph introduction and an animated demo of the review page, then gives a short quickstart, one headline results table, the architecture diagram, and compact data, deployment, status, limitations and documentation sections. Nothing measured is dropped: the full results text moves to docs/results.md and the full command reference to docs/usage.md, verbatim apart from headings and link paths. docs/assets/demo.gif is recorded from the published Flask demo page by scripts/demo/record_gif.py (real model output and the page's own script); it replaces the older screenshot.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README goes from 568 lines to 273 and is restructured for a first-time reader.
New order: banner → badges → one-paragraph introduction → animated demo (links to the live demo) → What it extracts → Quickstart → Results (one headline table, five bullets) → How it works (diagram) → Data → Deployment → Project status → Limitations → Documentation → License.
Nothing measured is dropped:
docs/results.md: the full results text (held-out test, prospective check, dev results, calibration, ablations, serving cost), moved verbatim apart from headings and link paths.docs/usage.md: the full command reference (corpus, train/evaluate, transformers, app, annotation).Demo GIF:
docs/assets/demo.gif(826 KB, 10 frames) is recorded from the published Flask demo page byscripts/demo/record_gif.pywith headless Chromium: real output of the released CRF and the page's own script (hover highlights the source span, answers, export). It replacesdocs/assets/app-review.png, an October screenshot of the rules baseline.Also fixed: the stale "phase 5" status badge (now release and live-demo badges); the diagram no longer shows the correction queue, which was never built.
All relative links and anchors in the README and both new docs were checked; 264 tests pass.